/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.camunda.bpm.engine.migration;

import org.camunda.bpm.engine.BadUserRequestException;
import org.camunda.bpm.engine.migration.MigrationPlanValidationReport;

/**
 * Thrown if a migration plan is not valid, e.g. because it contains instructions that can in general not be executed.
 * Contains a {@link MigrationPlanValidationReport} that contains the details for all validation erorrs.
 *
 * @author Thorben Lindhauer
 */
public class MigrationPlanValidationException extends BadUserRequestException {

  private static final long serialVersionUID = 1L;

  protected MigrationPlanValidationReport validationReport;

  public MigrationPlanValidationException(String message, MigrationPlanValidationReport validationReport) {
    super(message);
    this.validationReport = validationReport;
  }

  /**
   * A report with all invalid instructions
   */
  public MigrationPlanValidationReport getValidationReport() {
    return validationReport;
  }

}
